/**
 * # 参数列表实体类:
 *  Login - 登录
 * 
 * # 描述:
 *  使用指定的用户名和密码登录到系统。
 * 
 * Copyright (c), 上海沃恩信息科技有限公司.
 * All rights reserved.
 * Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

package com.waln.authority.authentication.args;

/**
 * 功能 登录 的参数列表。
 */
@pittypat.FunctionAnnotation(transaction = true)
public final class Login extends pittypat.FunctionArgs {
	/**
	 * 登录名称。
	 * <p>
	 * 用户的登录名称、编号、手机号码或电子邮件地址。
	 */
	@pittypat.ParameterAnnotation(position = 0, maxLength = 50)
	public String name;

	/**
	 * 登录密码。
	 * <p>
	 * 用户登录密码的明文。
	 */
	@pittypat.ParameterAnnotation(position = 1, maxLength = 30)
	public String password;

	/**
	 * 用户令牌。
	 * <p>
	 * 用户登录令牌。
	 */
	@pittypat.ParameterAnnotation(position = 2, direction = pittypat.ParameterDirection.OUT, fixedLength = true, maxLength = 36)
	public byte[] token;

	/**
	 * 用户信息。
	 * <p>
	 * 登录用户的用户信息。
	 */
	@pittypat.ParameterAnnotation(position = 3, direction = pittypat.ParameterDirection.OUT)
	public com.waln.authority.authentication.data.User user;

	/**
	 * 初始化 Login 类的一个新实例。
	 */
	public Login() {
		super();

		// 登录名称
		this.name = null;
		// 登录密码
		this.password = null;
		// 用户令牌
		this.token = null;
		// 用户信息
		this.user = null;
	}

	/**
	 * 获取指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @return 指定名称的参数值。
	 */
	@Override
	public Object getParameterValue(String name) {
		if (name == null || name.length() == 0) {
			return null;
		}

		switch (name.toLowerCase()) {
			case "name":
				return this.name;
			case "password":
				return this.password;
			case "token":
				return this.token;
			case "user":
				return this.user;
			default:
				return null;
		}
	}

	/**
	 * 设置指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @param value
	 * 			参数值。
	 * 
	 * @throws IllegalArgumentException
	 */
	@Override
	public void setParameterValue(String name, Object value) throws IllegalArgumentException {
		if (name == null || name.length() == 0) {
			throw new IllegalArgumentException("没有提供有效的参数名称。");
		}

		switch (name.toLowerCase()) {
			case "name":
				this.name = (String) value;
				break;
			case "password":
				this.password = (String) value;
				break;
			case "token":
				this.token = (byte[]) value;
				break;
			case "user":
				this.user = (com.waln.authority.authentication.data.User) value;
				break;
			default:
				throw new IllegalArgumentException(name + " 不是 " + this.getClass().getName() + " 的有效参数属性名称。");
		}
	}

	/**
	 * 将当前对象作为 JSON 字符串写入指定的文本流。
	 * 
	 * @param writer
	 * 			目标文本流。
	 * 
	 * @throws IllegalArgumentException
	 * @throws java.io.IOException
	 */
	@Override
	public void write(java.io.Writer writer) throws IllegalArgumentException, java.io.IOException {
		if (writer == null) {
			throw new IllegalArgumentException("writer 为 null。");
		}

		writer.write('{');

		// 登录名称
		writer.write("\"name\":");
		pittypat.Json.write(writer, this.name);
		writer.write(',');

		// 登录密码
		writer.write("\"password\":");
		pittypat.Json.write(writer, this.password);
		writer.write(',');

		// 用户令牌
		writer.write("\"token\":");
		pittypat.Json.write(writer, this.token);
		writer.write(',');

		// 用户信息
		writer.write("\"user\":");
		pittypat.Json.write(writer, this.user);

		writer.write('}');
	}
}
